//
//  WebBookmarksSource.h
//
//  Copyright (c) 2008-2009 Google Inc. All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions are
//  met:
//
//    * Redistributions of source code must retain the above copyright
//  notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
//  copyright notice, this list of conditions and the following disclaimer
//  in the documentation and/or other materials provided with the
//  distribution.
//    * Neither the name of Google Inc. nor the names of its
//  contributors may be used to endorse or promote products derived from
//  this software without specific prior written permission.
//
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
//  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
//  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
//  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
//  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
//  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
//  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
//  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
//  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
//  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
//  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//

/*!
 @header
 @discussion WebBookmarksSource
*/

#import <Vermilion/Vermilion.h>
#import <GTM/GTMFileSystemKQueue.h>

/*!
  An abstract base class simplifying the loading of bookmarks from various
  browsers.
*/
@interface WebBookmarksSource : HGSMemorySearchSource {
 @private
  GTMFileSystemKQueue *fileKQueue_;
  NSString *browserTypeName_;
  NSString *path_;
  HGSInvocationOperation *indexingOperation_;
  NSTimer *pathCheckTimer_;
}
- (id)initWithConfiguration:(NSDictionary *)configuration
            browserTypeName:(NSString *)browserTypeName
                fileToWatch:(NSString *)path;

- (void)indexResultNamed:(NSString *)name
                     URL:(NSString *)url
         otherAttributes:(NSDictionary *)otherAttributes
                    into:(HGSMemorySearchSourceDB *)database;

- (NSString *)domainURLForURLString:(NSString *)urlString;

- (void)fileChanged:(GTMFileSystemKQueue *)queue
              event:(GTMFileSystemKQueueEvents)event;

// Methods for subclasses to override
- (void)updateDatabase:(HGSMemorySearchSourceDB *)database
               forPath:(NSString *)path
             operation:(NSOperation *)operation;
@end
